docs(crypto-to-fiat): expand comprehensive guide with sandbox access, compliance flows, and implementation details#59
docs(crypto-to-fiat): expand comprehensive guide with sandbox access, compliance flows, and implementation details#59
Conversation
Update `api-features/crypto-to-fiat-payments.mdx` to remove hardcoded `docs.request.network` URLs and use Mintlify internal routes instead. - replaced EasyInvoice reference with `/request-network-api/easyinvoice-api-demo-app` - replaced crosschain reference with `/api-features/crosschain-payments` - ensures the page stays self-contained for cutover from legacy docs
api-features/crypto-to-fiat-payments.mdx to remove hardcoded docs.request.network URLs and use Mintlify internal routes instead. - replaced EasyInvoice reference with `/requ
Greptile SummaryThis PR completely rewrites the crypto-to-fiat payments documentation, replacing AI-generated placeholder content with comprehensive implementation guidance. The new content includes detailed onboarding flows, compliance requirements, endpoint references, and three sequence diagrams showing the complete integration process. Major improvements:
Issues found:
The documentation follows Mintlify component guidelines and technical writing best practices, providing clear step-by-step guidance for developers integrating crypto-to-fiat payments. Confidence Score: 4/5
Important Files Changed
Last reviewed commit: 46ae1bb |
|
|
||
| <Warning> | ||
| **AI-Generated Content** – This page was generated with AI assistance and may contain inaccuracies. While likely close to accurate, please verify critical details with the [stable documentation](https://docs.request.network) or [contact support](https://github.com/orgs/RequestNetwork/discussions). | ||
| I**mportant: Other Payment Types Use Real Funds** |
There was a problem hiding this comment.
typo in formatting - "I**mportant:" should be "**Important:"
| I**mportant: Other Payment Types Use Real Funds** | |
| **Important: Other Payment Types Use Real Funds** |
| RequestAPI-->>Platform: webhook: compliance.updated (kycStatus: pending/approved/rejected/failed) | ||
| Platform->>Payer: Show iframe for agreement signature | ||
| Payer->>Platform: Completes signature | ||
| Platform->>RequestAPI: PATCH /payer/{payerId} (agreement_status: completed) |
There was a problem hiding this comment.
inconsistent parameter naming - uses {payerId} but should be {clientUserId} per the "Understanding clientUserId" section
| Platform->>RequestAPI: PATCH /payer/{payerId} (agreement_status: completed) | |
| Platform->>RequestAPI: PATCH /payer/{clientUserId} (agreement_status: completed) |
|
|
||
| ### Relevant Endpoints | ||
|
|
||
| * `POST /payer`: Submit KYC application. |
There was a problem hiding this comment.
missing version prefix - should be /v2/payer for consistency with line 136
| * `POST /payer`: Submit KYC application. | |
| * `POST /v2/payer`: Submit KYC application. |
| participant RequestTech | ||
|
|
||
| Payee->>Platform: Submit bank info via Bank Account Form | ||
| Platform->>RequestAPI: POST /payer/{payerId}/payment-details (bank info) |
There was a problem hiding this comment.
inconsistent parameter naming - uses {payerId} but should be {clientUserId} per the "Understanding clientUserId" section
| Platform->>RequestAPI: POST /payer/{payerId}/payment-details (bank info) | |
| Platform->>RequestAPI: POST /payer/{clientUserId}/payment-details (bank info) |
| ```mermaid | ||
| sequenceDiagram | ||
| participant Payer | ||
| participant Platform | ||
| participant RequestAPI | ||
| participant RequestTech | ||
| participant Blockchain | ||
|
|
||
| Platform->>RequestAPI: GET payment calldata for request/{requestId}/pay | ||
| Platform->>Payer: Prompt to sign and send transaction | ||
| Payer->>Blockchain: Send crypto to Request Tech | ||
| Blockchain-->>RequestTech: Payment received | ||
| RequestTech-->>RequestAPI: offramp_update (webhook) | ||
| RequestAPI-->>Platform: webhook: payment.processing/payment.failed (subStatus: initiated, ongoing_checks, sending_fiat, fiat_sent, failed, etc.) | ||
| RequestTech->>Payee Bank: Offramp and deposit fiat |
There was a problem hiding this comment.
missing participant declaration - "Payee Bank" is used on line 239 but not declared in the participant list
| ```mermaid | |
| sequenceDiagram | |
| participant Payer | |
| participant Platform | |
| participant RequestAPI | |
| participant RequestTech | |
| participant Blockchain | |
| Platform->>RequestAPI: GET payment calldata for request/{requestId}/pay | |
| Platform->>Payer: Prompt to sign and send transaction | |
| Payer->>Blockchain: Send crypto to Request Tech | |
| Blockchain-->>RequestTech: Payment received | |
| RequestTech-->>RequestAPI: offramp_update (webhook) | |
| RequestAPI-->>Platform: webhook: payment.processing/payment.failed (subStatus: initiated, ongoing_checks, sending_fiat, fiat_sent, failed, etc.) | |
| RequestTech->>Payee Bank: Offramp and deposit fiat | |
| sequenceDiagram | |
| participant Payer | |
| participant Platform | |
| participant RequestAPI | |
| participant RequestTech | |
| participant Blockchain | |
| participant Payee Bank | |
| Platform->>RequestAPI: GET payment calldata for request/{requestId}/pay | |
| Platform->>Payer: Prompt to sign and send transaction | |
| Payer->>Blockchain: Send crypto to Request Tech | |
| Blockchain-->>RequestTech: Payment received | |
| RequestTech-->>RequestAPI: offramp_update (webhook) | |
| RequestAPI-->>Platform: webhook: payment.processing/payment.failed (subStatus: initiated, ongoing_checks, sending_fiat, fiat_sent, failed, etc.) | |
| RequestTech->>Payee Bank: Offramp and deposit fiat |

TL;DR
Completely rewrote the crypto-to-fiat payments documentation to provide comprehensive implementation guidance with detailed flows, endpoint references, and practical examples.
What changed?
clientUserIdconcept and explanation for user managementHow to test?
Why make this change?
The previous documentation was AI-generated placeholder content that lacked practical implementation details. This rewrite provides developers with actionable guidance, complete API references, and clear flow diagrams needed to successfully integrate crypto-to-fiat payments into their applications.